docs: explain the OpenTelemetry logs setup in the chart README#534
Merged
Conversation
|
Mateusz seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
witalisoft
reviewed
Jun 25, 2026
witalisoft
left a comment
witalisoft
left a comment
Contributor
There was a problem hiding this comment.
It is worth mentioning, especially if you want to push the logs yourself, that by default there is no TLS enabled for the OTEL endpoint in netdataOpentelemetry
| ### Collecting logs with OpenTelemetry | ||
|
|
||
| Netdata can ingest, store, and visualize your cluster's container logs through OpenTelemetry. | ||
| This relies on two components — **both disabled by default** and **both required** for logs to |
Contributor
There was a problem hiding this comment.
both required ? later on there is an info that otel-collector is an optional subchart
Contributor
Author
There was a problem hiding this comment.
it is explained more later but I will reword it a bit.
Add a "Collecting logs with OpenTelemetry" section to the chart README describing the two components required for log ingestion and why both must be enabled: - netdataOpentelemetry: the OTLP receiver (port 4317) that stores and displays logs; it does not collect them. - otel-collector: the optional DaemonSet that reads node-local container logs and forwards them over OTLP. It is replaceable by any OTLP-capable log pipeline. Also documents the end-to-end log flow. Regenerates charts/netdata/README.md via generate-documentation.sh.
M4itee
force-pushed
the
docs/otel-logs-readme
branch
from
3c4905c to
4a64128
Compare
Add a "Securing the endpoint with TLS" subsection to the OpenTelemetry logs documentation, covering the full end-to-end setup: - generate a self-signed certificate and key - create a Kubernetes TLS secret - mount it into the netdata-otel receiver and point the otel config at it (the tls_cert_path/tls_key_path must be set, mounting alone is not enough) - switch clients, including the bundled otel-collector, to TLS Regenerates charts/netdata/README.md via generate-documentation.sh.
witalisoft
approved these changes
Jun 26, 2026
ilyam8
approved these changes
Jun 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a concise Collecting logs with OpenTelemetry section to the chart README, explaining the two components involved in OpenTelemetry log ingestion and why both must be enabled.
Why
netdataOpentelemetryandotel-collectorboth exist invalues.yaml, but the README never explained their relationship — that both are required for logs to appear, and that the bundled collector is an optional, replaceable convenience. This previously required manual explanation to users.Changes
templates/netdata-README.md.gotmpl— new### Collecting logs with OpenTelemetrysubsection (placed after Persistent volumes), covering:netdataOpentelemetry— the OTLP receiver (port4317) that stores and displays logs; it does not collect them.otel-collector— the optionalDaemonSet(one pod per node) that reads node-local container logs and forwards them over OTLP; replaceable by any OTLP-capable pipeline.charts/netdata/README.md— regenerated via./generate-documentation.sh.Notes